home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / u_man / cat3 / Tk / winfo.z / winfo
Text File  |  1998-10-30  |  23KB  |  397 lines
  1.  
  2.  
  3.  
  4. wwwwiiiinnnnffffoooo((((3333TTTTkkkk))))                                                          wwwwiiiinnnnffffoooo((((3333TTTTkkkk))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      winfo - Return window-related information
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      wwwwiiiinnnnffffoooo _o_p_t_i_o_n ?_a_r_g _a_r_g ...?
  13.  
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      The wwwwiiiinnnnffffoooo command is used to retrieve information about windows managed
  17.      by Tk.  It can take any of a number of different forms, depending on the
  18.      _o_p_t_i_o_n argument.  The legal forms are:
  19.  
  20.      wwwwiiiinnnnffffoooo aaaattttoooommmm ?----ddddiiiissssppppllllaaaayyyyooooffff _w_i_n_d_o_w? _n_a_m_e
  21.           Returns a decimal string giving the integer identifier for the atom
  22.           whose name is _n_a_m_e.  If no atom exists with the name _n_a_m_e then a new
  23.           one is created.  If the ----ddddiiiissssppppllllaaaayyyyooooffff option is given then the atom is |
  24.           looked up on the display of _w_i_n_d_o_w;  otherwise it is looked up on   |
  25.           the display of the application's main window.
  26.  
  27.      wwwwiiiinnnnffffoooo aaaattttoooommmmnnnnaaaammmmeeee ?----ddddiiiissssppppllllaaaayyyyooooffff _w_i_n_d_o_w? _i_d
  28.           Returns the textual name for the atom whose integer identifier is
  29.           _i_d.  If the ----ddddiiiissssppppllllaaaayyyyooooffff option is given then the identifier is looked|
  30.           up on the display of _w_i_n_d_o_w;  otherwise it is looked up on the      |
  31.           display of the application's main window.  This command is the
  32.           inverse of the wwwwiiiinnnnffffoooo aaaattttoooommmm command.  It generates an error if no such
  33.           atom exists.
  34.  
  35.      wwwwiiiinnnnffffoooo cccceeeellllllllssss _w_i_n_d_o_w
  36.           Returns a decimal string giving the number of cells in the color map
  37.           for _w_i_n_d_o_w.
  38.  
  39.      wwwwiiiinnnnffffoooo cccchhhhiiiillllddddrrrreeeennnn _w_i_n_d_o_w
  40.           Returns a list containing the path names of all the children of
  41.           _w_i_n_d_o_w.  Top-level windows are returned as children of their logical
  42.           parents.
  43.  
  44.      wwwwiiiinnnnffffoooo ccccllllaaaassssssss _w_i_n_d_o_w
  45.           Returns the class name for _w_i_n_d_o_w.
  46.  
  47.      wwwwiiiinnnnffffoooo ccccoooolllloooorrrrmmmmaaaappppffffuuuullllllll _w_i_n_d_o_w
  48.           Returns 1 if the colormap for _w_i_n_d_o_w is known to be full, 0         |
  49.           otherwise.  The colormap for a window is ``known'' to be full if the|
  50.           last attempt to allocate a new color on that window failed and this |
  51.           application hasn't freed any colors in the colormap since the failed|
  52.           allocation.
  53.  
  54.      wwwwiiiinnnnffffoooo ccccoooonnnnttttaaaaiiiinnnniiiinnnngggg ?----ddddiiiissssppppllllaaaayyyyooooffff _w_i_n_d_o_w? _r_o_o_t_X _r_o_o_t_Y
  55.           Returns the path name for the window containing the point given by
  56.           _r_o_o_t_X and _r_o_o_t_Y.  _R_o_o_t_X and _r_o_o_t_Y are specified in screen units
  57.           (i.e.  any form acceptable to TTTTkkkk____GGGGeeeettttPPPPiiiixxxxeeeellllssss) in the coordinate system
  58.           of the root window (if a virtual-root window manager is in use then
  59.           the coordinate system of the virtual root window is used).  If the  |
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. wwwwiiiinnnnffffoooo((((3333TTTTkkkk))))                                                          wwwwiiiinnnnffffoooo((((3333TTTTkkkk))))
  71.  
  72.  
  73.  
  74.           ----ddddiiiissssppppllllaaaayyyyooooffff option is given then the coordinates refer to the screen |
  75.           containing _w_i_n_d_o_w;  otherwise they refer to the screen of the       |
  76.           application's main window.  If no window in this application
  77.           contains the point then an empty string is returned.  In selecting
  78.           the containing window, children are given higher priority than
  79.           parents and among siblings the highest one in the stacking order is
  80.           chosen.
  81.  
  82.      wwwwiiiinnnnffffoooo ddddeeeepppptttthhhh _w_i_n_d_o_w
  83.           Returns a decimal string giving the depth of _w_i_n_d_o_w (number of bits
  84.           per pixel).
  85.  
  86.      wwwwiiiinnnnffffoooo eeeexxxxiiiissssttttssss _w_i_n_d_o_w
  87.           Returns 1 if there exists a window named _w_i_n_d_o_w, 0 if no such window
  88.           exists.
  89.  
  90.      wwwwiiiinnnnffffoooo ffffppppiiiixxxxeeeellllssss _w_i_n_d_o_w _n_u_m_b_e_r
  91.           Returns a floating-point value giving the number of pixels in _w_i_n_d_o_w
  92.           corresponding to the distance given by _n_u_m_b_e_r.  _N_u_m_b_e_r may be
  93.           specified in any of the forms acceptable to TTTTkkkk____GGGGeeeettttSSSSccccrrrreeeeeeeennnnMMMMMMMM, such as
  94.           ``2.0c'' or ``1i''.  The return value may be fractional;  for an
  95.           integer value, use wwwwiiiinnnnffffoooo ppppiiiixxxxeeeellllssss.
  96.  
  97.      wwwwiiiinnnnffffoooo ggggeeeeoooommmmeeeettttrrrryyyy _w_i_n_d_o_w
  98.           Returns the geometry for _w_i_n_d_o_w, in the form _w_i_d_t_hxxxx_h_e_i_g_h_t++++_x++++_y.  All
  99.           dimensions are in pixels.
  100.  
  101.      wwwwiiiinnnnffffoooo hhhheeeeiiiigggghhhhtttt _w_i_n_d_o_w
  102.           Returns a decimal string giving _w_i_n_d_o_w's height in pixels.  When a
  103.           window is first created its height will be 1 pixel;  the height will
  104.           eventually be changed by a geometry manager to fulfill the window's
  105.           needs.  If you need the true height immediately after creating a
  106.           widget, invoke uuuuppppddddaaaatttteeee to force the geometry manager to arrange it,
  107.           or use wwwwiiiinnnnffffoooo rrrreeeeqqqqhhhheeeeiiiigggghhhhtttt to get the window's requested height instead
  108.           of its actual height.
  109.  
  110.      wwwwiiiinnnnffffoooo iiiidddd _w_i_n_d_o_w
  111.           Returns a hexadecimal string indicating the X identifier for _w_i_n_d_o_w.
  112.  
  113.      wwwwiiiinnnnffffoooo iiiinnnntttteeeerrrrppppssss ?----ddddiiiissssppppllllaaaayyyyooooffff _w_i_n_d_o_w?
  114.           Returns a list whose members are the names of all Tcl interpreters
  115.           (e.g. all Tk-based applications) currently registered for a         |
  116.           particular display.  If the ----ddddiiiissssppppllllaaaayyyyooooffff option is given then the     |
  117.           return value refers to the display of _w_i_n_d_o_w;  otherwise it refers  |
  118.           to the display of the application's main window.
  119.  
  120.      wwwwiiiinnnnffffoooo iiiissssmmmmaaaappppppppeeeedddd _w_i_n_d_o_w
  121.           Returns 1111 if _w_i_n_d_o_w is currently mapped, 0000 otherwise.
  122.  
  123.      wwwwiiiinnnnffffoooo mmmmaaaannnnaaaaggggeeeerrrr _w_i_n_d_o_w
  124.           Returns the name of the geometry manager currently responsible for  |
  125.           _w_i_n_d_o_w, or an empty string if _w_i_n_d_o_w isn't managed by any geometry  |
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. wwwwiiiinnnnffffoooo((((3333TTTTkkkk))))                                                          wwwwiiiinnnnffffoooo((((3333TTTTkkkk))))
  137.  
  138.  
  139.  
  140.           manager.  The name is usually the name of the Tcl command for the   |
  141.           geometry manager, such as ppppaaaacccckkkk or ppppllllaaaacccceeee.  If the geometry manager is|
  142.           a widget, such as canvases or text, the name is the widget's class  |
  143.           command, such as ccccaaaannnnvvvvaaaassss.
  144.  
  145.      wwwwiiiinnnnffffoooo nnnnaaaammmmeeee _w_i_n_d_o_w
  146.           Returns _w_i_n_d_o_w's name (i.e. its name within its parent, as opposed
  147.           to its full path name).  The command wwwwiiiinnnnffffoooo nnnnaaaammmmeeee .... will return the
  148.           name of the application.
  149.  
  150.      wwwwiiiinnnnffffoooo ppppaaaarrrreeeennnntttt _w_i_n_d_o_w
  151.           Returns the path name of _w_i_n_d_o_w's parent, or an empty string if
  152.           _w_i_n_d_o_w is the main window of the application.
  153.  
  154.      wwwwiiiinnnnffffoooo ppppaaaatttthhhhnnnnaaaammmmeeee ?----ddddiiiissssppppllllaaaayyyyooooffff _w_i_n_d_o_w? _i_d
  155.           Returns the path name of the window whose X identifier is _i_d.  _I_d
  156.           must be a decimal, hexadecimal, or octal integer and must correspond
  157.           to a window in the invoking application.  If the ----ddddiiiissssppppllllaaaayyyyooooffff option  |
  158.           is given then the identifier is looked up on the display of _w_i_n_d_o_w; |
  159.           otherwise it is looked up on the display of the application's main  |
  160.           window.
  161.  
  162.      wwwwiiiinnnnffffoooo ppppiiiixxxxeeeellllssss _w_i_n_d_o_w _n_u_m_b_e_r
  163.           Returns the number of pixels in _w_i_n_d_o_w corresponding to the distance
  164.           given by _n_u_m_b_e_r.  _N_u_m_b_e_r may be specified in any of the forms
  165.           acceptable to TTTTkkkk____GGGGeeeettttPPPPiiiixxxxeeeellllssss, such as ``2.0c'' or ``1i''.  The result
  166.           is rounded to the nearest integer value;  for a fractional result,
  167.           use wwwwiiiinnnnffffoooo ffffppppiiiixxxxeeeellllssss.
  168.  
  169.      wwwwiiiinnnnffffoooo ppppooooiiiinnnntttteeeerrrrxxxx _w_i_n_d_o_w
  170.           If the mouse pointer is on the same screen as _w_i_n_d_o_w, returns the   |
  171.           pointer's x coordinate, measured in pixels in the screen's root     |
  172.           window.  If a virtual root window is in use on the screen, the      |
  173.           position is measured in the virtual root.  If the mouse pointer     |
  174.           isn't on the same screen as _w_i_n_d_o_w then -1 is returned.
  175.  
  176.      wwwwiiiinnnnffffoooo ppppooooiiiinnnntttteeeerrrrxxxxyyyy _w_i_n_d_o_w
  177.           If the mouse pointer is on the same screen as _w_i_n_d_o_w, returns a list|
  178.           with two elements, which are the pointer's x and y coordinates      |
  179.           measured in pixels in the screen's root window.  If a virtual root  |
  180.           window is in use on the screen, the position is computed in the     |
  181.           virtual root.  If the mouse pointer isn't on the same screen as     |
  182.           _w_i_n_d_o_w then both of the returned coordinates are -1.
  183.  
  184.      wwwwiiiinnnnffffoooo ppppooooiiiinnnntttteeeerrrryyyy _w_i_n_d_o_w
  185.           If the mouse pointer is on the same screen as _w_i_n_d_o_w, returns the   |
  186.           pointer's y coordinate, measured in pixels in the screen's root     |
  187.           window.  If a virtual root window is in use on the screen, the      |
  188.           position is computed in the virtual root.  If the mouse pointer     |
  189.           isn't on the same screen as _w_i_n_d_o_w then -1 is returned.
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. wwwwiiiinnnnffffoooo((((3333TTTTkkkk))))                                                          wwwwiiiinnnnffffoooo((((3333TTTTkkkk))))
  203.  
  204.  
  205.  
  206.      wwwwiiiinnnnffffoooo rrrreeeeqqqqhhhheeeeiiiigggghhhhtttt _w_i_n_d_o_w
  207.           Returns a decimal string giving _w_i_n_d_o_w's requested height, in
  208.           pixels.  This is the value used by _w_i_n_d_o_w's geometry manager to
  209.           compute its geometry.
  210.  
  211.      wwwwiiiinnnnffffoooo rrrreeeeqqqqwwwwiiiiddddtttthhhh _w_i_n_d_o_w
  212.           Returns a decimal string giving _w_i_n_d_o_w's requested width, in pixels.
  213.           This is the value used by _w_i_n_d_o_w's geometry manager to compute its
  214.           geometry.
  215.  
  216.      wwwwiiiinnnnffffoooo rrrrggggbbbb _w_i_n_d_o_w _c_o_l_o_r
  217.           Returns a list containing three decimal values, which are the red,
  218.           green, and blue intensities that correspond to _c_o_l_o_r in the window
  219.           given by _w_i_n_d_o_w.  _C_o_l_o_r may be specified in any of the forms
  220.           acceptable for a color option.
  221.  
  222.      wwwwiiiinnnnffffoooo rrrroooooooottttxxxx _w_i_n_d_o_w
  223.           Returns a decimal string giving the x-coordinate, in the root window
  224.           of the screen, of the upper-left corner of _w_i_n_d_o_w's border (or
  225.           _w_i_n_d_o_w if it has no border).
  226.  
  227.      wwwwiiiinnnnffffoooo rrrroooooooottttyyyy _w_i_n_d_o_w
  228.           Returns a decimal string giving the y-coordinate, in the root window
  229.           of the screen, of the upper-left corner of _w_i_n_d_o_w's border (or
  230.           _w_i_n_d_o_w if it has no border).
  231.  
  232.      wwwwiiiinnnnffffoooo ssssccccrrrreeeeeeeennnn _w_i_n_d_o_w
  233.           Returns the name of the screen associated with _w_i_n_d_o_w, in the form
  234.           _d_i_s_p_l_a_y_N_a_m_e._s_c_r_e_e_n_I_n_d_e_x.
  235.  
  236.      wwwwiiiinnnnffffoooo ssssccccrrrreeeeeeeennnncccceeeellllllllssss _w_i_n_d_o_w
  237.           Returns a decimal string giving the number of cells in the default
  238.           color map for _w_i_n_d_o_w's screen.
  239.  
  240.      wwwwiiiinnnnffffoooo ssssccccrrrreeeeeeeennnnddddeeeepppptttthhhh _w_i_n_d_o_w
  241.           Returns a decimal string giving the depth of the root window of
  242.           _w_i_n_d_o_w's screen (number of bits per pixel).
  243.  
  244.      wwwwiiiinnnnffffoooo ssssccccrrrreeeeeeeennnnhhhheeeeiiiigggghhhhtttt _w_i_n_d_o_w
  245.           Returns a decimal string giving the height of _w_i_n_d_o_w's screen, in
  246.           pixels.
  247.  
  248.      wwwwiiiinnnnffffoooo ssssccccrrrreeeeeeeennnnmmmmmmmmhhhheeeeiiiigggghhhhtttt _w_i_n_d_o_w
  249.           Returns a decimal string giving the height of _w_i_n_d_o_w's screen, in
  250.           millimeters.
  251.  
  252.      wwwwiiiinnnnffffoooo ssssccccrrrreeeeeeeennnnmmmmmmmmwwwwiiiiddddtttthhhh _w_i_n_d_o_w
  253.           Returns a decimal string giving the width of _w_i_n_d_o_w's screen, in
  254.           millimeters.
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. wwwwiiiinnnnffffoooo((((3333TTTTkkkk))))                                                          wwwwiiiinnnnffffoooo((((3333TTTTkkkk))))
  269.  
  270.  
  271.  
  272.      wwwwiiiinnnnffffoooo ssssccccrrrreeeeeeeennnnvvvviiiissssuuuuaaaallll _w_i_n_d_o_w
  273.           Returns one of the following strings to indicate the default visual
  274.           class for _w_i_n_d_o_w's screen: ddddiiiirrrreeeeccccttttccccoooolllloooorrrr, ggggrrrraaaayyyyssssccccaaaalllleeee, ppppsssseeeeuuuuddddooooccccoooolllloooorrrr,
  275.           ssssttttaaaattttiiiiccccccccoooolllloooorrrr, ssssttttaaaattttiiiiccccggggrrrraaaayyyy, or ttttrrrruuuueeeeccccoooolllloooorrrr.
  276.  
  277.      wwwwiiiinnnnffffoooo ssssccccrrrreeeeeeeennnnwwwwiiiiddddtttthhhh _w_i_n_d_o_w
  278.           Returns a decimal string giving the width of _w_i_n_d_o_w's screen, in
  279.           pixels.
  280.  
  281.      wwwwiiiinnnnffffoooo sssseeeerrrrvvvveeeerrrr _w_i_n_d_o_w
  282.           Returns a string containing information about the server for        |
  283.           _w_i_n_d_o_w's display.  The exact format of this string may vary from    |
  284.           platform to platform.  For X servers the string has the form        |
  285.           ``XXXX_m_a_j_o_rRRRR_m_i_n_o_r _v_e_n_d_o_r _v_e_n_d_o_r_V_e_r_s_i_o_n'' where _m_a_j_o_r and _m_i_n_o_r are the |
  286.           version and revision numbers provided by the server (e.g., XXXX11111111RRRR5555),  |
  287.           _v_e_n_d_o_r is the name of the vendor for the server, and _v_e_n_d_o_r_R_e_l_e_a_s_e  |
  288.           is an integer release number provided by the server.
  289.  
  290.      wwwwiiiinnnnffffoooo ttttoooopppplllleeeevvvveeeellll _w_i_n_d_o_w
  291.           Returns the path name of the top-level window containing _w_i_n_d_o_w.
  292.  
  293.      wwwwiiiinnnnffffoooo vvvviiiieeeewwwwaaaabbbblllleeee _w_i_n_d_o_w
  294.           Returns 1 if _w_i_n_d_o_w and all of its ancestors up through the nearest |
  295.           toplevel window are mapped.  Returns 0 if any of these windows are  |
  296.           not mapped.
  297.  
  298.      wwwwiiiinnnnffffoooo vvvviiiissssuuuuaaaallll _w_i_n_d_o_w
  299.           Returns one of the following strings to indicate the visual class
  300.           for _w_i_n_d_o_w: ddddiiiirrrreeeeccccttttccccoooolllloooorrrr, ggggrrrraaaayyyyssssccccaaaalllleeee, ppppsssseeeeuuuuddddooooccccoooolllloooorrrr, ssssttttaaaattttiiiiccccccccoooolllloooorrrr,
  301.           ssssttttaaaattttiiiiccccggggrrrraaaayyyy, or ttttrrrruuuueeeeccccoooolllloooorrrr.
  302.  
  303.      wwwwiiiinnnnffffoooo vvvviiiissssuuuuaaaallllssssaaaavvvvaaaaiiiillllaaaabbbblllleeee _w_i_n_d_o_w
  304.           Returns a list whose elements describe the visuals available for    |
  305.           _w_i_n_d_o_w's screen.  Each element consists of a visual class followed  |
  306.           by an integer depth.  The class has the same form as returned by    |
  307.           wwwwiiiinnnnffffoooo vvvviiiissssuuuuaaaallll.  The depth gives the number of bits per pixel in the  |
  308.           visual.
  309.  
  310.      wwwwiiiinnnnffffoooo vvvvrrrrooooooootttthhhheeeeiiiigggghhhhtttt _w_i_n_d_o_w
  311.           Returns the height of the virtual root window associated with _w_i_n_d_o_w
  312.           if there is one;  otherwise returns the height of _w_i_n_d_o_w's screen.
  313.  
  314.      wwwwiiiinnnnffffoooo vvvvrrrroooooooottttwwwwiiiiddddtttthhhh _w_i_n_d_o_w
  315.           Returns the width of the virtual root window associated with _w_i_n_d_o_w
  316.           if there is one;  otherwise returns the width of _w_i_n_d_o_w's screen.
  317.  
  318.      wwwwiiiinnnnffffoooo vvvvrrrroooooooottttxxxx _w_i_n_d_o_w
  319.           Returns the x-offset of the virtual root window associated with
  320.           _w_i_n_d_o_w, relative to the root window of its screen.  This is normally
  321.           either zero or negative.  Returns 0 if there is no virtual root
  322.           window for _w_i_n_d_o_w.
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334. wwwwiiiinnnnffffoooo((((3333TTTTkkkk))))                                                          wwwwiiiinnnnffffoooo((((3333TTTTkkkk))))
  335.  
  336.  
  337.  
  338.      wwwwiiiinnnnffffoooo vvvvrrrroooooooottttyyyy _w_i_n_d_o_w
  339.           Returns the y-offset of the virtual root window associated with
  340.           _w_i_n_d_o_w, relative to the root window of its screen.  This is normally
  341.           either zero or negative.  Returns 0 if there is no virtual root
  342.           window for _w_i_n_d_o_w.
  343.  
  344.      wwwwiiiinnnnffffoooo wwwwiiiiddddtttthhhh _w_i_n_d_o_w
  345.           Returns a decimal string giving _w_i_n_d_o_w's width in pixels.  When a
  346.           window is first created its width will be 1 pixel;  the width will
  347.           eventually be changed by a geometry manager to fulfill the window's
  348.           needs.  If you need the true width immediately after creating a
  349.           widget, invoke uuuuppppddddaaaatttteeee to force the geometry manager to arrange it,
  350.           or use wwwwiiiinnnnffffoooo rrrreeeeqqqqwwwwiiiiddddtttthhhh to get the window's requested width instead of
  351.           its actual width.
  352.  
  353.      wwwwiiiinnnnffffoooo xxxx _w_i_n_d_o_w
  354.           Returns a decimal string giving the x-coordinate, in _w_i_n_d_o_w's
  355.           parent, of the upper-left corner of _w_i_n_d_o_w's border (or _w_i_n_d_o_w if it
  356.           has no border).
  357.  
  358.      wwwwiiiinnnnffffoooo yyyy _w_i_n_d_o_w
  359.           Returns a decimal string giving the y-coordinate, in _w_i_n_d_o_w's
  360.           parent, of the upper-left corner of _w_i_n_d_o_w's border (or _w_i_n_d_o_w if it
  361.           has no border).
  362.  
  363.  
  364. KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS
  365.      atom, children, class, geometry, height, identifier, information,
  366.      interpreters, mapped, parent, path name, screen, virtual root, width,
  367.      window
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.                                                                         PPPPaaaaggggeeee 6666
  394.  
  395.  
  396.  
  397.